Fetching a list of Rate Card Set Versions

Request

Rate Card Set Versions are only accessible to Administrators on the account.

This endpoint returns structured Rate Card Set Version objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the rate_card_set_versions top-level JSON key. Please see our Response Format section for more information.

Query

created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

effective_on_datestring, (date)

Returns Rate Card Set Versions that are effective on the requested date. The date should be in <ISO_8601 Date Format> eg. '2014-02-25'. The date must be in ISO 8601 format.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

rate_card_set (RateCardSet) - The Rate Card Set this version belongs to.
rate_card_versions (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc and created_at:desc.

Default:"created_at:asc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

rate_card_set_idinteger, (int32)

Restricts Rate Card Set Versions to the specified Rate Card Set.

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/rate_card_set_versions?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&effective_on_date=2019-08-24&include=string&only=string&order=created_at%3Aasc&page=1&per_page=20&rate_card_set_id=0&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Rate Card Set Versions have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

rate_card_set_versionsobject

rate_card_setsobject

rate_card_versionsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "rate_card_set_versions": {
    "property1": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    },
    "property2": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    }
  },
  "rate_card_sets": {
    "property1": {
      "account_default": true,
      "active_currencies": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "default_currencies": [
        "string"
      ],
      "destroyable": true,
      "rate_card_ids": [
        "string"
      ],
      "rate_card_set_version_ids": [
        "string"
      ],
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ]
    },
    "property2": {
      "account_default": true,
      "active_currencies": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "default_currencies": [
        "string"
      ],
      "destroyable": true,
      "rate_card_ids": [
        "string"
      ],
      "rate_card_set_version_ids": [
        "string"
      ],
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ]
    }
  },
  "rate_card_versions": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}